<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>option.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_ui_option.js.html">option.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2007 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview A menu item class that supports selection state.
<a name="line17"></a> *
<a name="line18"></a> * @author attila@google.com (Attila Bodis)
<a name="line19"></a> */
<a name="line20"></a>
<a name="line21"></a>goog.provide(&#39;goog.ui.Option&#39;);
<a name="line22"></a>
<a name="line23"></a>goog.require(&#39;goog.ui.Component.EventType&#39;);
<a name="line24"></a>goog.require(&#39;goog.ui.ControlContent&#39;);
<a name="line25"></a>goog.require(&#39;goog.ui.MenuItem&#39;);
<a name="line26"></a>goog.require(&#39;goog.ui.registry&#39;);
<a name="line27"></a>
<a name="line28"></a>
<a name="line29"></a>
<a name="line30"></a>/**
<a name="line31"></a> * Class representing a menu option.  This is just a convenience class that
<a name="line32"></a> * extends {@link goog.ui.MenuItem} by making it selectable.
<a name="line33"></a> *
<a name="line34"></a> * @param {goog.ui.ControlContent} content Text caption or DOM structure to
<a name="line35"></a> *     display as the content of the item (use to add icons or styling to
<a name="line36"></a> *     menus).
<a name="line37"></a> * @param {*=} opt_model Data/model associated with the menu item.
<a name="line38"></a> * @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper used for
<a name="line39"></a> *     document interactions.
<a name="line40"></a> * @constructor
<a name="line41"></a> * @extends {goog.ui.MenuItem}
<a name="line42"></a> */
<a name="line43"></a>goog.ui.Option = function(content, opt_model, opt_domHelper) {
<a name="line44"></a>  goog.ui.MenuItem.call(this, content, opt_model, opt_domHelper);
<a name="line45"></a>  this.setSelectable(true);
<a name="line46"></a>};
<a name="line47"></a>goog.inherits(goog.ui.Option, goog.ui.MenuItem);
<a name="line48"></a>
<a name="line49"></a>
<a name="line50"></a>/**
<a name="line51"></a> * Performs the appropriate action when the option is activated by the user.
<a name="line52"></a> * Overrides the superclass implementation by not changing the selection state
<a name="line53"></a> * of the option and not dispatching any SELECTED events, for backwards
<a name="line54"></a> * compatibility with existing uses of this class.
<a name="line55"></a> * @param {goog.events.Event} e Mouse or key event that triggered the action.
<a name="line56"></a> * @return {boolean} True if the action was allowed to proceed, false otherwise.
<a name="line57"></a> * @override
<a name="line58"></a> */
<a name="line59"></a>goog.ui.Option.prototype.performActionInternal = function(e) {
<a name="line60"></a>  return this.dispatchEvent(goog.ui.Component.EventType.ACTION);
<a name="line61"></a>};
<a name="line62"></a>
<a name="line63"></a>
<a name="line64"></a>// Register a decorator factory function for goog.ui.Options.
<a name="line65"></a>goog.ui.registry.setDecoratorByClassName(
<a name="line66"></a>    goog.getCssName(&#39;goog-option&#39;), function() {
<a name="line67"></a>  // Option defaults to using MenuItemRenderer.
<a name="line68"></a>  return new goog.ui.Option(null);
<a name="line69"></a>});
</pre>


</body>
</html>
